home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 9 / Night Owl CD-ROM (NOPV9) (Night Owl Publisher) (1993).ISO / 038a / comchk18.zip / COMMCHK.DOC next >
Text File  |  1993-02-07  |  7KB  |  234 lines
  1. Commchk.doc    Version 1.8
  2.  
  3.     Documentation for the Serial protocol analizer
  4.  
  5.     Commchk is used to analyze information on a serial line by
  6.     intercepting the information and allowing you to view the
  7.     captured information in either a HEX format or in an ASCII format.
  8.     The information captured may also be saved in files stored on disk.
  9.  
  10.     Commchk performs this function by routing any information read from
  11.     com1 to com2 and any information read from com2 to com1, while
  12.     capturing the information for display and or saving to a file.
  13.  
  14.     Commchk will split the screen into 2 windows, an upper window
  15.     and a lower window. the upper window will display the information
  16.     captured from com1 and sent to com2. The lower window will
  17.     display the information captured from com2 and sent to com1.
  18.  
  19.     This program was developed to allow analyzing information being
  20.     send from a host computer to a slave computer to determine the
  21.     source of errors that were getting into the system.
  22.  
  23.     Alternatively, Commchk can be used to allow a computer that does
  24.     not have a modem to access the modem of a second computer.
  25.  
  26.     Commchk command line options are summarized as follows.
  27.  
  28.         -1, -2, -3, -4    Setup ports to use. The first entry becomes
  29.                 the port designated com1 at the top of the
  30.                 screen. The second entry becomes the bottom
  31.                 half of the screen.
  32.  
  33.         -I 0/1/2    all commands up to the next "I" command
  34.                     are for the identified port.
  35.                     0 = both ports
  36.                     1 = com1
  37.                     2 = com2
  38.  
  39.         -B baud        baud rates from 300 baud to 57600
  40.                 baud are supported.
  41.  
  42.         -C        Turn on TSC Computer CRC checking
  43.                 This will then generate an additional file
  44.                 with a "C.FIL" appended when disk capture
  45.                 is turned on.
  46.  
  47.         -F file name    the file name must not have a length of
  48.                 greater than 7 characters, not including
  49.                 the path name. It is used to create create
  50.                 2 files, one for information read from com1,
  51.                 and one for information read from com2 by
  52.                 appending the communications port number
  53.                 and .fil to the end of the file name.
  54.                 IE: -f test
  55.                     generates test1.fil - com1 info
  56.                           test2.fil - com2 info
  57.  
  58.                      -f c:\commchk\test
  59.                     generates c:\commchk\test1.fil
  60.                           c:\commchk\test2.fil
  61.  
  62.         -H Help off    Turn off the initial help screen
  63.  
  64.         -M        Turn Modem/Line status checking on/off
  65.  
  66.         -N         Set the port name to display on the upper
  67.                 line of the port display screen
  68.  
  69.         -P parity    Allowable paritys are
  70.                 EVEN, ODD, NONE
  71.  
  72.         -W word length    7 or 8 bits
  73.  
  74.         -R Resident    As soon as the program gets the serial ports
  75.                 initialized it will imiadiately shell out to
  76.                 dos. Information will continue to pass thru
  77.                 the serial ports from one to the other.
  78.  
  79.         -S stop bits    1 or 2 stop bits
  80.  
  81.     Example startup command:
  82.  
  83.         COMMCHK -I 1 -B 1200 -P E -W 7 -S 2 -I 2 -B 4800 -P N -W 8
  84.  
  85.         THIS SETS COM1 TO 1200 BAUD, 7 BIT, EVEN PARITY, 2 STOP BITS
  86.         AND COM2 TO 4800 BAUD, NO PARITY, 8 BIT.
  87.  
  88.  
  89.     Commchk uses an initalization file named "COMMCHK.INI" to initialize
  90.         the serial port parameters.
  91.  
  92.         If no initialization file is found then the ports will default
  93.         to the default PC serial port values. Values for all ports do
  94.         not need to be supplied.
  95.  
  96.         Only values for the ports you want to change from the default.
  97.  
  98.         You may also place command line parameters in the commchk.ini file.
  99.         The first character on a line containing command line parameters
  100.         "MUST" be a "-" character or the line is interpeted as a serial port
  101.         setup line as described in Section "A" below.
  102.  
  103.  
  104.     Section A:
  105.         The format of the ini file is as follows:
  106.  
  107.  
  108. port,base address,interrupt vector        <== serial port setup
  109. port,base address,interrupt vector
  110.  
  111. -M -B 4800                                <== command line parameters.
  112. -P
  113.  
  114.         The allowable ports are 1 - 6.
  115.  
  116.  
  117.     The commchk display is as follows:
  118. PORT1 BUFFER     0.0   SYSTEM BUFFER      0.0   RTS DTR DSR CTS      0     0
  119.          ^ SIZE OF THE BUFFER FOR PORT 1
  120.                       ^ SIZE OF THE BUFFER USED FOR DISPLAY
  121.                  TOTAL NUMBER OF SERIAL PORT ERRORS  ^
  122.                  LAST RECIEVED SERIAL PORT ERROR CODE      ^
  123.  
  124.     Commchk keyboard commands are summarized as follows.
  125.  
  126.         F1 key - Help
  127.  
  128.         F4 key - Allow changing the serial port characteristics online.
  129.  
  130.         O  key - Open the currently active capture files
  131.  
  132.         C  key - Close the currently active capture files
  133.  
  134.         D  key - Toggle video display on and off
  135.  
  136.         F  key - Flush out all current serial port buffers
  137.                  of all characters.
  138.  
  139.         A  key - place the display in ASCII mode
  140.  
  141.         H  key - place the display in HEX mode
  142.  
  143.         I  key - Reinitialize the port, also clears all buffers
  144.  
  145.         Q  key - Quit
  146.  
  147.         R  key - Toggle the RTS line
  148.  
  149.         S  key - Shell out to dos - interrups and information flow from
  150.                  one port to the other continues to occur
  151.  
  152.         T  key - Toggle the DTR line
  153.  
  154.         L  key - Toggle the line display status line
  155.  
  156.         M  key - Toggle the Line and Modem status interrupt on/off
  157.                  if you are on a system where the unused lines are allowed to
  158.                  float then they may cause numerous interrupts to occur and
  159.                  appear to lock your system. so turning these interrupts off
  160.                  may fix this problem.
  161.  
  162.     Commchk Startup defaults are as follows
  163.         2400 Baud, 8 Data bits, 1 Stop bit, No parity
  164.         No capture file, com1 and com2 ports
  165.  
  166.  
  167. Revision History:
  168.  
  169.     11/5/90  -     Fixed serial protocol data errors.
  170.  
  171.  
  172.     11/13/90 -     Modified help routine to not interrupt serial data flow.
  173.  
  174.             Added Flush buffer command.
  175.  
  176.             Modified asynchronous character send routine
  177.             errors that caused loss of characters.
  178.  
  179.             Added code to allow setting of the serial
  180.             ports to different parameters.
  181.  
  182.             Removed SHAREWARE message.
  183.  
  184.     VERSION 1.3
  185.     11/27/90 -     Modified code to use only 8088/8086 code.
  186.  
  187.             Added a line at the bottom of the status windows
  188.             that displays statistics about the serial port
  189.  
  190.             Added code to allow toggling the RTS and DTR lines
  191.  
  192.             Modified the asyncronous lines to have all serial port
  193.             IO completely asyncronously driven to assist in
  194.             performance on slower computers.
  195.  
  196.             Added code to allow changing the serial port
  197.             characteristics while the program is running (F4 key).
  198.  
  199.     VERSION 1.4/1.5
  200.     04/26/92 -     Added the -H Startup command to turn off the initial
  201.             help screen.
  202.  
  203.             Added the -R Command to perform an imiadiate shell to
  204.             Dos.
  205.  
  206.     VERSION 1.6
  207.     11/06/92    Added Port names to display for identifying the port
  208.             Added CRC Checking for testing
  209.             Added "C" command to turn CRC testing on
  210.  
  211.     VERSION 1.7
  212.     01/29/93 - Modified to allow any baud rate from 50 to 115200 baud to
  213.             be used.
  214.  
  215.          - Added comm ports 5 & 6.
  216.  
  217.          - Added "COMMCHK.INI" initialization file.
  218.  
  219.          - Added ability to use 5 and 6 bit word length.
  220.  
  221.     VERSION 1.8
  222.     02/07/93 - Fixed command line parsing for 5 and 6 bit word length
  223.  
  224.          - Added ability to turn off Line/Modem status interrupts
  225.  
  226.          - Added ability to place command line commands in the initialization
  227.            file "COMMCHK.INI"
  228.  
  229.     Written using Turbo C++, Borland C++ by:
  230.  
  231.         Timothy L. Garrison
  232.         3003 W. Marquette Woods Rd.
  233.         Stevensville Mi. 49127
  234.